Список промокодов в заказе

Запрос позволяет получить список промокодов по конкретному заказу.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/codes/list?order_id=<идентификатор заказа>
&limit=<количество записей> 
&cursor=<отметка от предыдущего запроса>

Заголовки запроса

• Authorization: Bearer <OAuth-токен>
  Процесс получения токена описан в разделе Начало работы.

• X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

• order_id — идентификатор заказа.

Запрос может содержать следующие необязательные параметры:

• limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.
• cursor — отметка запроса (возвращается в теле ответа на предыдущий запрос). Для запроса первой страницы параметр указывать не нужно, для запросов последующих страниц — обязательно.

Описание полей ответа

В ответе могут содержаться следующие поля:

Структура элементов массива codes:

Структура элементов массива usages:

Пример запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/codes/list?order_id=fa0...6f3
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

{
  "codes": [
    {
      "code": "b2b...862",
      "id": "e6z...60b",
      "status": "used",
      "usages": [
        {
          "used_at": "2024-10-29T14:31:57.803131Z"
        }
      ]
    },
    {
      "code": "b2b...397",
      "id": "ca5...b30",
      "status": "active",
      "usages": []
    }
  ]
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

• 200 — запрос выполнен успешно.
• 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
• 403 — у клиента не хватает прав на выполнение данного запроса.
  • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
  • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
• 404 — заказ не найден.